home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / gui / bgui11b.lha / docs / infoclass.doc < prev    next >
Encoding:
Text File  |  1994-11-23  |  3.8 KB  |  128 lines
  1.  
  2.            $RCSfile: infoclass.doc,v $
  3.         Description: Infoclass documentation.
  4.           Copyright: (C) Copyright 1994 Jaba Development.
  5.                      (C) Copyright 1994 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8.             $Author: jaba $
  9.           $Revision: 1.1 $
  10.               $Date: 1994/07/04 21:05:30 $
  11. ------------------------------------------------------------------------------
  12.  
  13. TABLE OF CONTENTS
  14.  
  15. infoclass/--background--
  16. infoclass/Methods
  17. infoclass/Attributes
  18.  
  19. infoclass/--background--                              infoclass/--background--
  20.  
  21.     NAME
  22.         Class:          infoclass
  23.         Superclass:     baseclass
  24.         Include File:   <libraries/bgui.h>
  25.  
  26.     FUNCTION
  27.         To  provide  a  general  multi-line  text gadget which can be used for
  28.         on-line  help  or  general information purposes. It has the ability to
  29.         handle  different  text  style,  colors  and text justifications. Also
  30.         C-style formatting codes are allowed.
  31.  
  32.         A  good  example  of  the  usage  of this class is the BGUI_RequestA()
  33.         routine.  This  routine  uses  an infoclass object to display the body
  34.         text.
  35.  
  36.         This gadget does not send out notification events.
  37.  
  38. infoclass/Methods                                            infoclass/Methods
  39.  
  40.     NEW METHODS
  41.         None.
  42.  
  43.     CHANGED METHODS
  44.         None.
  45.  
  46. infoclass/Attributes                                      infoclass/Attributes
  47.  
  48.     NAME
  49.         INFO_TextFormat -- ( STRPTR )
  50.  
  51.     FUNCTION
  52.         Set  the  textual  contents  of the gadget object. You can use C-style
  53.         formatting  codes in the text and in addition to that you may also use
  54.         any of the following command sequences:
  55.  
  56.         \33b    - Bold text.
  57.         \33i    - Italics text.
  58.         \33u    - Underlined text.
  59.         \33n    - Normal text.
  60.         \33c    - Center this and the following lines.
  61.         \33l    - Left-justify this and the following lines.
  62.         \33r    - Right-justify this and the following lines.
  63.         \33d<n> - Set drawinfo pen <n>.
  64.         \33p<n> - Set pen <n>.
  65.         \n      - Start a new line of text.
  66.  
  67.         Please note the the \33c, \33l and \33r command sequences  can only be
  68.         used at the beginning of a new line.
  69.  
  70.         NOTE: Since  V38  of  the  library  it  is  possible  to  use locale's
  71.               FormatString()  formatting  codes.  Locale  specific  formatting
  72.               codes will only work when the locale.library is available.
  73.  
  74.         Default is NULL. Applicability is (ISU).
  75.  
  76.     SEE ALSO
  77.         <intuition/screens.h>, exec.library/RawDoFmt(), INFO_Args
  78.  
  79.     NAME
  80.         INFO_Args -- ( ULONG * )
  81.  
  82.     FUNCTION
  83.         Set  the arguments accoording to the C-style formatting codes found in
  84.         the text.
  85.  
  86.         Default is NULL. Applicability is (ISU).
  87.  
  88.     SEE ALSO
  89.         exec.library/RawDoFmt(), INFO_TextFormat
  90.  
  91.     NAME
  92.         INFO_MinLines -- ( ULONG )
  93.  
  94.     FUNCTION
  95.         Set  the  minimum  number  of  lines  the object should display at all
  96.         times.  This  is  taken into consideration when to object it's minimum
  97.         size is calculated.
  98.  
  99.         Default is 1. Applicability is (I).
  100.  
  101.     SEE ALSO
  102.         INFO_FixTextWidth
  103.  
  104.     NAME
  105.         INFO_FixTextWidth -- ( BOOL )
  106.  
  107.     FUNCTION
  108.         To tell the object that it's minimum width may not be smaller than the
  109.         width  of  the  longest  line  in the text plus the offsets and border
  110.         thickness.
  111.  
  112.         Default is FALSE. Applicability is (I).
  113.  
  114.     SEE ALSO
  115.         INFO_HorizOffset, INFO_VertOffset, INFO_MinLines
  116.  
  117.     NAME
  118.         INFO_HorizOffset, INFO_VertOffset -- ( ULONG )
  119.  
  120.     FUNCTION
  121.         Set  the  horizontal  and  vertical  offset from the object borders at
  122.         which the text is rendered.
  123.  
  124.         Defaults are 8 horizontally and 6 vertically. Applicability is (I).
  125.  
  126.     SEE ALSO
  127.         INFO_FixTextWidth
  128.